Find a Schedule

Returns a schedule based on the search criteria

Method

/API3/tasks/findSchedule

  • API Section: /API3/tasks
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin
    • Domain Admin
    • Pro

Method Signature

Input Parameters

Name

searchCriteria

Object Type

Description

The search criteria object for finding a schedule.

Output Response

Successful Result Code

200

Response List Type

Description of Response Type

The schedule listing object.. Note that the response is returned as a list of items of this object type.

Notes

Schedules are available for different types of content: data flow processing, publications, alerts etc.

Examples

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/tasks/findSchedule" \
 -d '{
  "searchCriteria" : {
    "searchValue" : "searchValue"
  }
}'
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.TasksServiceApi;

import java.util.*;
import java.time.*;

public class TasksServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TasksServiceApi apiInstance = new TasksServiceApi();
        // Initialize the searchCriteria parameter object for the call
        ScheduleSearchCriteria searchCriteria = ; // Create the input object for the operation, type: ScheduleSearchCriteria 

        try {
            // "array[ScheduleViewObject]" is only psaudo-code to symbolize list of type and not the actual usage 
            array[ScheduleViewObject] result = apiInstance.findSchedule(searchCriteria);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksServiceApi#findSchedule");
            e.printStackTrace();
        }
    }
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.TasksServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const searchCriteria = ; // {ScheduleSearchCriteria} 

api.findSchedule(searchCriteria).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class findScheduleExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new TasksServiceApi();
        // Initialize the searchCriteria parameter object for the call
        var searchCriteria = new ScheduleSearchCriteria(); // ScheduleSearchCriteria | 

        try {
            // Returns a schedule based on the search criteria
            // "array[ScheduleViewObject]" is only psaudo-code to symbolize array of type and not the actual usage 
            array[ScheduleViewObject] result = apiInstance.findSchedule(searchCriteria);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling TasksServiceApi.findSchedule: " + e.Message );
        }
    }
}

import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import TasksServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = TasksServiceApi(api_client)
    # Initialize the searchCriteria parameter object for the call
    searchCriteria =  # ScheduleSearchCriteria | 

    try:
        # Returns a schedule based on the search criteria
        api_response = api_instance.find_schedule(searchCriteria)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TasksServiceApi->findSchedule: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TasksServiceApi();
$searchCriteria = ; // ScheduleSearchCriteria | 

try {
    $result = $api_instance->findSchedule($searchCriteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TasksServiceApi->findSchedule: ', $e->getMessage(), PHP_EOL;
}
?>